fix: fix incorrect REST request serialization#2549
Conversation
Summary of ChangesHello @parthea, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses a critical bug in the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request correctly fixes a bug in the REST request serialization by using the input message's is_proto_plus_type attribute instead of the output message's. The changes in the Jinja2 templates are accurate, and the resulting updates to the golden files are as expected. I've added one comment regarding the use of a bare except in the generated code, which is a pre-existing issue but would be good to address for more robust error handling.
| method = transcoded_request['method'] | ||
| try: | ||
| request_payload = json_format.MessageToJson(request) | ||
| request_payload = type(request).to_json(request) |
There was a problem hiding this comment.
The except: on the next line is a bare except, which is a bad practice as it catches all exceptions, including system-exiting ones like SystemExit and KeyboardInterrupt. This can make debugging difficult and hide underlying issues. It would be better to catch a more specific exception, like Exception.
While there's a TODO in the template to remove this try/except block, improving it in the meantime would be beneficial.
This change should be applied to the template file: gapic/templates/%namespace/%name_%version/%sub/services/%service/_shared_macros.j2.
Suggested change in the template:
except Exception:There was a problem hiding this comment.
Ack. I'm hesitant to change this now but I'll file a bug to follow up on it.
There was a problem hiding this comment.
Filed #2550 to fix this throughout the code base
This PR is needed to address the issue in googleapis/gapic-generator-python#2548. See googleapis/gapic-generator-python#2549 for more details. The release notes and changes for generated client libraries will be added in a separate PR.
3 participants
Fixes #2548
This PR fixes a bug in the templates when calling the
rest_call_method_commonshared macro. The value of theis_proto_plus_typeargument was set tomethod.output.ident.is_proto_plus_typebut it should bemethod.input.ident.is_proto_plus_typebecauseis_proto_plus_typeis used to serialize the request message (input message rather than output message).